API Documentation
Public Member Functions | List of all members
nkWinUi::EditBox Class Referenceabstract

A graphical single line edit box. More...

Inheritance diagram for nkWinUi::EditBox:
nkWinUi::Component nkExport::Exportable

Public Member Functions

 EditBox ()
 
 ~EditBox ()
 
editBoxKeyCallback getKeySpecializedCallback () const
 
virtual void setOnlyNumbers (bool value)
 
virtual void setPlaceHolder (const std::string_view &text)
 
virtual void setCaretPosition (unsigned int letterIndex)=0
 
void setKeySpecializedCallback (editBoxKeyCallback value)
 
virtual void exportIntrospection (nkExport::Node *rootNode) override
 
virtual void importClassFromTree (nkExport::Node *rootNode) override
 
- Public Member Functions inherited from nkWinUi::Component
 Component ()
 
virtual ~Component ()
 
LayoutgetLayout () const
 
nkMaths::Point getPositionInParent () const
 
nkMaths::Point getPositionInScreen () const
 
int getWidth () const
 
int getHeight () const
 
nkMaths::Rectangle getArea () const
 
virtual nkMaths::Point getBorderExtents () const
 
virtual int getLayoutAllowedWidth () const
 
virtual int getLayoutAllowedHeight () const
 
virtual int getLayoutAllowedOffsetX () const
 
virtual int getLayoutAllowedOffsetY () const
 
bool isInitialized () const
 
ComponentgetParentComponent () const
 
COMPONENT_TYPE getComponentType () const
 
const char * getComponentName () const
 
bool getVisibility () const
 
virtual const char * getLabel () const
 
void * getData () const
 
bool isEnabled () const
 
bool isForegroundWindow () const
 
unsigned int getZDepth () const
 
bool getVisibleOnLoad () const
 
virtual LayoutsetLayout (LAYOUT_TYPE layoutType)
 
virtual void setPositionInParent (nkMaths::Point position)
 
virtual void setPositionInScreen (nkMaths::Point position)
 
virtual void setSize (int width, int height)
 
virtual void setWidth (int width)
 
virtual void setHeight (int height)
 
void setMinSize (unsigned int width, unsigned int height)
 
void setMaxSize (unsigned int width, unsigned int height)
 
void setRatio (float widthOverHeight)
 
virtual void setArea (nkMaths::Rectangle area)
 
virtual void setParentComponent (Component *parent, bool makeItVisible=true)
 
virtual void setLabel (const std::string_view &label)
 
void setComponentName (const std::string_view &name)
 
virtual void setVisibility (bool value)
 
void setData (void *data)
 
void setEnabled (bool value)
 
void setVisibleOnLoad (bool value)
 
void addChild (Component *child, bool makeItVisible=true)
 
void removeChild (Component *child)
 
void removeChild (unsigned int index)
 
ComponentgetChild (unsigned int index)
 
unsigned int getChildIndex (Component *child)
 
void unloadWithChildren ()
 
void loadWithChildren ()
 
void updateZDepth ()
 
void bringToForeground ()
 
void focusWindow ()
 
nkMaths::Point getCoordRelativeFromAbsolute (const nkMaths::Point &absCoords)
 
nkMaths::Point getCoordAbsoluteFromRelative (const nkMaths::Point &relCoords)
 
virtual void load ()=0
 
virtual void unload ()=0
 
virtual void updateWindow ()
 
nkImages::Image paintToImage ()
 
void onSized ()
 
ContextMenucreateContextMenu ()
 
ContextMenugetCurrentContextMenu ()
 
void shutContextMenu ()
 
virtual void exportClassToTree (nkExport::Node *rootNode) override
 
- Public Member Functions inherited from nkExport::Exportable
 Exportable ()
 
virtual ~Exportable ()
 

Detailed Description

A graphical single line edit box.

Constructor & Destructor Documentation

◆ EditBox()

nkWinUi::EditBox::EditBox ( )

Constructor.

◆ ~EditBox()

nkWinUi::EditBox::~EditBox ( )

Destructor.

Member Function Documentation

◆ getKeySpecializedCallback()

editBoxKeyCallback nkWinUi::EditBox::getKeySpecializedCallback ( ) const
Returns
The key callback assigned.

◆ setOnlyNumbers()

virtual void nkWinUi::EditBox::setOnlyNumbers ( bool  value)
virtual

Sets whether the edit box should only accept numbers in input.

Parameters
valueIf the edit box should only accept numbers (true) or not (false).

◆ setPlaceHolder()

virtual void nkWinUi::EditBox::setPlaceHolder ( const std::string_view &  text)
virtual

Sets the place holder shown when no text is present in the edit box.

Parameters
textThe text to show as a place holder.

◆ setCaretPosition()

virtual void nkWinUi::EditBox::setCaretPosition ( unsigned int  letterIndex)
pure virtual

Sets the caret position within the edit box.

Parameters
letterIndexThe index at which to set the caret. Will be clamped to the valid interval of possible positions.

◆ setKeySpecializedCallback()

void nkWinUi::EditBox::setKeySpecializedCallback ( editBoxKeyCallback  value)

Sets the key callback. Will be called over the global key callback set in the InputSystem.

Parameters
valueThe callback to use.

◆ exportIntrospection()

virtual void nkWinUi::EditBox::exportIntrospection ( nkExport::Node rootNode)
overridevirtual

◆ importClassFromTree()

virtual void nkWinUi::EditBox::importClassFromTree ( nkExport::Node rootNode)
overridevirtual

The documentation for this class was generated from the following file: